package com.google.code.mochaccino.framework.ui.demo.pages;
/*
 * Copyright 2012 Claude Houle claude.houle@gmail.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import com.google.code.mochaccino.framework.ui.components.TreeNode;
import java.util.List;

/**
 *
 */
public interface FrameService {

	/** Return the environment name. */
	String getEnvironment();

	/** Return the online help url */
	String getHelpUrl();

	/** Return a list of modules for the navigation tree. */
	List<TreeNode> getTreeNodes( Object principal );

	/** Return the Settings URL for this credential */
	String getSettingsUrl( Object principal );

	/**
	 * Return the fully qualified username for the specified credential. The credential is the name
	 * submitted at the login, the fully qualified is whatever we want displayed to the user identified
	 * him.
	 * <p/>
	 * For example:
	 * choule is the credential
	 * Claude Houle is the fully qualified name
	 */
	String getFullName( Object principal );
}
